<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../print.css" type="text/css" media="print">
<meta content="OverlayManager,com.modestmaps.OverlayManager,overlays,addOverlay,hideAll,hideGroup,removeGroup,removeOverlay,showAll,showGroup,temporaryHide" name="keywords">
<title>com.modestmaps.OverlayManager</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'OverlayManager - The San Diego Union-Tribune extensions library for the ModestMaps API - - PolylineOverlay and Supporting Classes';
				var baseRef = '../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">The San Diego Union-Tribune Mapping extensions for the ModestMaps API -- PolylineOverlay and Supporting Classes</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../all-classes.html')" href="../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../all-classes.html')" href="../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../index-list.html')" href="../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../index.html?com/modestmaps/OverlayManager.html&amp;com/modestmaps/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;OverlayManager</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a>&nbsp;| <a href="#methodSummary">Methods</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class OverlayManager"); titleBar_setSubNav(false,true,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.modestmaps</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class OverlayManager</td>
</tr>
</table>
<p></p>
  Manages a set of Overlay instances for a given Map. 
  <p>
  Includes methods to add and remove an overlay from the map,
  show/hide all overlays, and show/hide overlays as a group, using a common
  groupID string to identify related overlays.
  </p>
  <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">the official ModestMaps site<br>
<a href="Map.html" target="">Map</a>
<br>Overlay<br>PolylineOverlay</div>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#overlays">overlays</a> : IList<div class="summaryTableDescription">[read-only]
   Return a list of the overlays being managed by this OverlayManager.</div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
</table>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#OverlayManager()">OverlayManager</a>(map:<a href="Map.html">Map</a>)</div>
<div class="summaryTableDescription">
   Constructor -- creates a new OverlayManager and adds it to the map.</div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#addOverlay()">addOverlay</a>(overlay:<a href="extras/Overlay.html">Overlay</a>):void</div>
<div class="summaryTableDescription">
   Adds an overlay to the manager, adds it to the map, and
   sets its visibility property.</div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#hideAll()">hideAll</a>():void</div>
<div class="summaryTableDescription"> Hide all overlays </div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#hideGroup()">hideGroup</a>(groupID:String):void</div>
<div class="summaryTableDescription"> 
   Hide all overlays matching the specified groupID.</div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeGroup()">removeGroup</a>(groupID:String):void</div>
<div class="summaryTableDescription">
   Remove all overlays matching the specified groupID.</div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#removeOverlay()">removeOverlay</a>(overlay:<a href="extras/Overlay.html">Overlay</a>):void</div>
<div class="summaryTableDescription">
   Removes the specified overlay from the manager and the map.</div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#showAll()">showAll</a>():void</div>
<div class="summaryTableDescription"> Show all overlays </div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#showGroup()">showGroup</a>(groupID:String):void</div>
<div class="summaryTableDescription"> 
   Show all overlays matching the specified groupID.</div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#temporaryHide()">temporaryHide</a>(hide:Boolean):void</div>
<div class="summaryTableDescription"> 
   Temporarily hides and then unhides overlays, e.g., during a zoom operation.</div>
</td><td class="summaryTableOwnerCol">OverlayManager</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="overlays"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">overlays</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>overlays:IList</code>&nbsp;&nbsp;[read-only]<p>
   Return a list of the overlays being managed by this OverlayManager.
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public function get overlays():IList</code>
<br>
</div>
<a name="constructorDetail"></a>
<div class="detailSectionHeader">Constructor detail</div>
<a name="OverlayManager()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">OverlayManager</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">constructor</td>
</tr>
</table>
<div class="detailBody">
<code>public function OverlayManager(map:<a href="Map.html">Map</a>)</code><p>
   Constructor -- creates a new OverlayManager and adds it to the map.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">map</span>:<a href="Map.html">Map</a></code> &mdash; is the Map instance.
   </td>
</tr>
</table>
</div>
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="addOverlay()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">addOverlay</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public function addOverlay(overlay:<a href="extras/Overlay.html">Overlay</a>):void</code><p>
   Adds an overlay to the manager, adds it to the map, and
   sets its visibility property.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">overlay</span>:<a href="extras/Overlay.html">Overlay</a></code> &mdash; is the Overlay instance to be added.
   </td>
</tr>
</table>
</div>
<a name="hideAll()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">hideAll</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function hideAll():void</code><p> Hide all overlays </p></div>
<a name="hideGroup()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">hideGroup</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function hideGroup(groupID:String):void</code><p> 
   Hide all overlays matching the specified groupID.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">groupID</span>:String</code> &mdash; identifies the overlays that will be hidden.
   </td>
</tr>
</table>
</div>
<a name="removeGroup()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeGroup</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removeGroup(groupID:String):void</code><p>
   Remove all overlays matching the specified groupID.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">groupID</span>:String</code> &mdash; identifies the overlays to be removed.
   </td>
</tr>
</table>
</div>
<a name="removeOverlay()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">removeOverlay</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function removeOverlay(overlay:<a href="extras/Overlay.html">Overlay</a>):void</code><p>
   Removes the specified overlay from the manager and the map. 
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">overlay</span>:<a href="extras/Overlay.html">Overlay</a></code> &mdash; is the Overlay instance to be removed.
   </td>
</tr>
</table>
</div>
<a name="showAll()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">showAll</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function showAll():void</code><p> Show all overlays </p></div>
<a name="showGroup()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">showGroup</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function showGroup(groupID:String):void</code><p> 
   Show all overlays matching the specified groupID.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">groupID</span>:String</code> &mdash; identifies the overlays that will be shown.
   </td>
</tr>
</table>
</div>
<a name="temporaryHide()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">temporaryHide</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public function temporaryHide(hide:Boolean):void</code><p> 
   Temporarily hides and then unhides overlays, e.g., during a zoom operation.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">hide</span>:Boolean</code> &mdash; specifies whether to hide or un-hide the overlays -- hide if <code>true</code>,
   un-hide if <code>false</code>.
   </td>
</tr>
</table>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">Extensions to Modestmaps by The San Diego Union-Tribune, June 2008</center>
</div>
</body>
</html>
<!--Extensions to Modestmaps by The San Diego Union-Tribune, June 2008-->
